Version 1.1 #3
Merged
Version 1.1 #3
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
This PR introduces improvements for CI/CD automation, installation instructions, and package enhancements including global CLI command definitions and automated shebang prepending.
- Adds GitHub Actions workflows for unit tests and NPM publishing.
- Updates README.md with clearer installation and usage instructions.
- Introduces a shebang-prepending script for CLI files to ensure correct execution when installed globally.
Reviewed Changes
Copilot reviewed 5 out of 7 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| prepend-shebang.js | Adds shebang and file permission handling for server and client CLI scripts. |
| README.md | Updates installation instructions and usage details with npm and manual options. |
| .github/workflows/unit-tests.yml | Defines a workflow to run tests, linting, and builds on PRs and pushes to main. |
| .github/workflows/npm-publish.yml | Implements automated publishing to NPM upon release. |
Files not reviewed (2)
- browser-global.sh: Language not supported
- package.json: Language not supported
prepend-shebang.js
Outdated
| const path = require('path'); | ||
|
|
||
| const shebang = '#!/usr/bin/env node\n'; | ||
| const files = ['o2f-server.js', 'o2f-client.js']; |
There was a problem hiding this comment.
The 'files' array is missing 'o2f-browser.js', which is defined as a CLI command in package.json. Consider adding it to ensure that the shebang is prepended for all relevant CLI files.
Suggested change
| const files = ['o2f-server.js', 'o2f-client.js']; | |
| const files = ['o2f-server.js', 'o2f-client.js', 'o2f-browser.js']; |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
CI/CD Automation
.github/workflows/npm-publish.ymlto automate publishing to NPM upon release. This workflow includes steps for building, testing, and publishing the package..github/workflows/unit-tests.ymlto run linting, unit tests, and builds on pull requests and pushes to themainbranch.Installation and Usage Improvements
README.mdwith detailed installation instructions, including a new recommended method to install via npm and usage instructions for both host and container environments. [1] [2]browser-global.sh, a script to handle browser requests in containerized environments, and documented its usage.Package Enhancements
package.jsonto:o2f-server,o2f-client,o2f-browser) for global installation.Build Process
prepend-shebang.js, a script to prepend shebangs to CLI files and make them executable. This ensures proper behavior when installed globally.